Query engine for recursive searches in a self-describing data system

ABSTRACT

A method for performing recursive searching of items of a data structure having a data mode includes creating an instance of a query definition, the instance of the query definition comprising a unique identifier, specifying one or more elements of the query definition, providing the query definition as an input to a query engine. The method further includes the operations of determining, by the query engine, query execution instructions based on the query definition, the query instructions specifying a recursive level-by-level search until a terminal node of the data structure is reached, obtaining results of a query executed based on the query execution instructions; and outputting query results.

CROSS-REFERENCE TO RELATED APPLICATIONS

This application is a continuation of U.S. application Ser. No.16/387,205 filed Apr. 17, 2019 titled “Query Engine for RecursiveSearches in a Self-Describing Data System,” which claims the benefit ofand priority to Provisional Application Ser. No. 62/663,777 filed Apr.27, 2018 titled “Query Engine for Recursive Searches in aSelf-Describing Data System.” These applications are hereby incorporatedby reference in their entireties for all purposes.

TECHNICAL FIELD

This disclosure relates generally to search technology. Morespecifically, this disclosure relates to a query engine for recursivesearches in a self-describing data system.

BACKGROUND

The technical challenges associated with implementing a search, or queryfunctionality on data expressed in certain markup languages and storedin a database, in particular, a relational database, such as a .SQLserver database include, without limitation, difficulty in formulatingand executing recursive search queries as well as searching across adynamic data model. Specifically, recursive searches of relationaldatabases require iterative and repetitive reformulation of the searchquery. Further, certain markup languages do not support queryfunctionality over across dynamic data models, as changes to the datamodel will block the execution of the search, typically resulting in anerror message indicating that the database schema is different than anexpected schema.

SUMMARY

This disclosure provides a query engine for recursive searches in aself-describing data system.

In a first embodiment, a method for performing recursive searching ofitems of a data structure having a data model includes creating aninstance of a query definition, the instance of the query definitioncomprising a unique identifier, specifying one or more elements of thequery definition, providing the query definition as an input to a queryengine. The method further includes the operations of determining, bythe query engine, query execution instructions based on the querydefinition, the query instructions specifying a recursive level-by-levelsearch until a terminal node of the data structure is reached, obtainingresults of a query executed based on the query execution instructions;and outputting query results.

In a second embodiment, a query engine includes a processor, a memorycontaining instructions, which when executed by the processor, cause thequery engine to create an instance of a query definition, the instanceof the query definition comprising a unique identifier, obtain one ormore elements of the query definition, and provide the query definitionas an input to the query engine. The instructions, when executed by theprocessor, further cause the query engine to determine query executioninstructions based on the query definition, the query executioninstructions specifying a recursive level-by-level search until aterminal node of the data structure is reached, obtain results of aquery executed based on the query instructions; and output the queryresults.

In a third embodiment, a non-transitory computer-readable mediumcontains program code, which when executed by a processor, cause a queryengine to create an instance of a query definition, the instance of thequery definition comprising a unique identifier, obtain one or moreelements of the query definition, and provide the query definition as aninput to the query engine. The program code, when executed by theprocessor, further cause the query engine to determine query executioninstructions based on the query definition, the query executioninstructions specifying a recursive level-by-level search until aterminal node of the data structure is reached, obtain results of aquery executed based on the query instructions, and output the queryresults.

Other technical features may be readily apparent to one skilled in theart from the following figures, descriptions, and claims.

Before undertaking the DETAILED DESCRIPTION below, it may beadvantageous to set forth definitions of certain words and phrases usedthroughout this patent document. The term “couple” and its derivativesrefer to any direct or indirect communication between two or moreelements, whether or not those elements are in physical contact with oneanother. The terms “transmit,” “receive,” and “communicate,” as well asderivatives thereof, encompass both direct and indirect communication.The terms “include” and “comprise,” as well as derivatives thereof, meaninclusion without limitation. The term “or” is inclusive, meaningand/or. The phrase “associated with,” as well as derivatives thereof,means to include, be included within, interconnect with, contain, becontained within, connect to or with, couple to or with, be communicablewith, cooperate with, interleave, juxtapose, be proximate to, be boundto or with, have, have a property of, have a relationship to or with, orthe like. The term “controller” means any device, system or part thereofthat controls at least one operation. Such a controller may beimplemented in hardware or a combination of hardware and software and/orfirmware. The functionality associated with any particular controllermay be centralized or distributed, whether locally or remotely. Thephrase “at least one of,” when used with a list of items, means thatdifferent combinations of one or more of the listed items may be used,and only one item in the list may be needed. For example, “at least oneof: A, B, and C” includes any of the following combinations: A, B, C, Aand B, A and C, B and C, and A and B and C.

Moreover, various functions described below can be implemented orsupported by one or more computer programs, each of which is formed fromcomputer readable program code and embodied in a computer readablemedium. The terms “application” and “program” refer to one or morecomputer programs, software components, sets of instructions,procedures, functions, objects, classes, instances, related data, or aportion thereof adapted for implementation in a suitable computerreadable program code. The phrase “computer readable program code”includes any type of computer code, including source code, object code,and executable code. The phrase “computer readable medium” includes anytype of medium capable of being accessed by a computer, such as readonly memory (ROM), random access memory (RAM), a hard disk drive, acompact disc (CD), a digital video disc (DVD), or any other type ofmemory. A “non-transitory” computer readable medium excludes wired,wireless, optical, or other communication links that transporttransitory electrical or other signals. A non-transitory computerreadable medium includes media where data can be permanently stored andmedia where data can be stored and later overwritten, such as arewritable optical disc or an erasable memory device.

Definitions for other certain words and phrases are provided throughoutthis patent document. Those of ordinary skill in the art shouldunderstand that in many if not most instances, such definitions apply toprior as well as future uses of such defined words and phrases.

BRIEF DESCRIPTION OF THE DRAWINGS

For a more complete understanding of this disclosure and its advantages,reference is now made to the following description, taken in conjunctionwith the accompanying drawings, in which:

FIG. 1 illustrates an example of a tag creating an instance of an itemin a self describing data system according to various embodiments ofthis disclosure;

FIG. 2 illustrates, at a structural level aspects of the configurationof an item in a self-describing data system according to variousembodiments of this disclosure;

FIG. 3 illustrates an example of a configuration document for an itemaccording to certain embodiments of this disclosure;

FIG. 4 illustrates an example of a system architecture for implementinga query engine for performing recursive searches in a self-describingdata system according to various embodiments of this disclosure;

FIG. 5 illustrates operations of a query engine in one embodiment of amethod for performing recursive searches in a self-describing datasystem;

FIG. 6 illustrates, at a structural level, one example of a data modelsupporting a query definition item according to embodiments of thisdisclosure;

FIGS. 7A and 7B illustrate an example of a configuration documentsetting forth the configuration of a query based on a self-describingdata model according to certain embodiments of this disclosure;

FIG. 8 at a structural level, an exemplary embodiment of an extension ofa data model 800 for configuring recursive searches of a self-describingdata system;

FIG. 9 illustrates an example of a query configuration documentcomprising an instance of an item belonging to the query parameter itemtype which provides a user-defined filter on the query response dataset;

FIG. 10 illustrates an embodiment of a query configuration documentcomprising an instance of an item belonging to the query parameter itemtype;

FIG. 11 illustrates, in wireframe format, an example of a queryexecution path for a query performed according to embodiments of thisdisclosure;

FIGS. 12A and 12B illustrate an example of a markup language documentcomprising query results obtained and outputted according to variousembodiments of this disclosure;

FIG. 13 illustrates of query results output in a tree grid formataccording to various embodiments of this disclosure;

FIGS. 14A and 14B illustrate query results outputted according toembodiments of this disclosure;

FIG. 15 illustrates a data model for implementing extended properties ina self-describing data system according to various embodiments of thisdisclosure; and

FIG. 16 illustrates an example of a data model for implementing extendedclassification according to embodiments of this disclosure.

DETAILED DESCRIPTION

FIGS. 1 through 16 , discussed below, and the various embodiments usedto describe the principles of this disclosure in this patent documentare by way of illustration only and should not be construed in any wayto limit the scope of the disclosure. Those skilled in the art willunderstand that the principles of this disclosure may be implemented inany suitably arranged wireless communication system.

FIG. 1 illustrates an example of an <item> tag 100 defining an instanceof an item in a self-describing data system according to variousembodiments of this disclosure.

According to certain embodiments, the foundational element of aself-describing data system is an item, instances of which may bemaintained in persistent storage in a relational database. According tocertain embodiments, the configuration and properties of an item may beexpressed in a markup language, such as extensible markup language(XML), or Aras Markup Language (AML), which, as described in greaterdetail herein, follows a repeating“/Item/Relationships/Item/Relationships” pattern to describe itemconfigurations.

Further, in the non-limiting example of FIG. 1 , <item> tag 100 definesan instance of an item, which is in turn, an instance of an ItemType,which is itself an item. In this way, the instance of an item defined by<item> tag 100 belongs to a self-describing data system. Further, insome embodiments each ItemType has a relational table in the database,whose columns map to the property names of the ItemType.

According to various embodiments, the instance of the item defined by<item> tag 100 comprises three principal attributes, a type 105, an ID110 and an action 115. It should be noted that the following threeattributes are not the only attributes which can be applied to an item.

In the non-limiting example shown in FIG. 1 , type 105 comprises anItemType name for the instance of the item defined by <item> tag 100.According to certain embodiments, type 105 expresses an ItemType namefor the item defined by <item> tag 100. In the non-limiting example ofFIG. 1 , the name of the item type is the string “Part.” According tovarious embodiments, the namespace for the “type” attribute isextensible and can be dynamically changed, as new names for ItemTypesbecome necessary. For example, in some embodiments, the item defined by<item> tag 100 may be a piece of data associated with a manufacturingprocess. In such cases, additional names for ItemTypes, such as “BOM”(Bill of Materials) may become necessary.

According to various embodiments, ID 110 comprises a unique identifierfor the instance of an item created by <item> tag 100. In thenon-limiting example of FIG. 1 , ID 110 comprises the string“ABCDEF012345.” According to certain embodiments, ID 110 provides,without limitation, a primary key for the instance of the item for thepurposes of providing query results.

In some embodiments, action 115 comprises a method to be applied to theinstance of an item defined by <item> tag 100. In the non-limitingexample of FIG. 1 , the method specified by action 115 is a “get.” Theinstance of an item type defined by <item> tag 100 may, in someembodiments, include one or more Relationship tags, from which a querymay be constructed. According to various embodiments, the methodsspecified by action 115 may be implemented by an API, for example, anAPI implementing the Aras Innovator Object Model or Item Object Model.

FIG. 2 illustrates, at a structural level, aspects of the configuration200 of an item in a self-describing data system according to variousembodiments of this disclosure.

Referring to the non-limiting example of FIG. 2 , the item described byconfiguration 200 may be initially defined by an <item> tag 205, whichaccording to various embodiments, embodies the syntax and threeprincipal attributes of <item> tag 100 shown in FIG. 1 .

According to certain embodiments, the configuration 200 of an item maybe expressed as a markup language document (for example, an AMLdocument). In some embodiments, item 200's configuration may beexpressed through an “/Item/Relationships/Item/Relationships” pattern inan AML document. Further, the document expressing the configuration 200of the item may contain data 220 (which are themselves, items),structure or relationships 210 (which are hierarchical items) and logic,which, as shown in the example of FIG. 1 , may be expressed through anaction attribute (for example, action 115 shown in FIG. 1 ) of eachitem.

In the non-limiting example of FIG. 2 , relationships 210 comprisehierarchical items. According to certain embodiments, an item'srelationship to one or more other items may be expressed through aRelationshipType item 212. In some embodiments, wherein the documentsetting forth an item's configuration is written in AML, an instance ofa RelationshipType item may be defined by using the <Relationships> tag,which is a container tag holding a set of relationship items.

As shown in FIG. 2 , according to certain embodiments, the set ofrelationship items may comprise one or more of the following threeproperties, an is_relationship 214, a source relationship 216 and atarget_relationship 218.

In some embodiments, when the RelationshipType 212 is created,is_relationship 214 is also created. Is_relationship 214 comprises anitem, and its id is the value of the relationship_id property ofRelationshipType 212. As such, is_relationship 214 operates to providean ItemType pairing to RelationshipType 212, and to define aRelationshipType rule and an ItemType for storing thesource_relationship 216 and target_relationship 218 properties of theRelationshipType item 212.

According to certain embodiments, source_relationship 216 is a propertyof RelationshipType 212 which comprises a link pointing to a child item.Similarly, target_relationship 218 is a property of RelationshipType212, which comprises a link to a child item.

As shown in the non-limiting example of FIG. 2 , the configuration 200of an item may further comprise data 220 expressed as values ofproperties, wherein the properties may further be specified byattributes.

According to certain embodiments, a property 222 defines data for anitem. Examples of properties may include, for example, a cost for anitem, which could be expressed in AML or XML in the form: “<cost>232.13</cost> ” indicating that a particular item has a cost value of“232.13” units.

According to certain embodiments, items of data for an item may befurther specified with an attribute 224, which may be analogized asmetadata for the item or property, and controlling logic and methodsassociated with the item. For example, an attribute may define aconditional, producing an AML or XML expression of the form “<costcondition=”between“> 10.00 and 50.00</cost>” In this example, theproperty “cost” is further specified through the “between” attribute forwhich the values 10.00 and 50.00 are specified.

According to certain embodiments, the configuration 200 for an item mayfurther include history data for the item, showing some or all of theprevious configurations of the item.

FIG. 3 illustrates an example of a configuration document 300 for anitem according to certain embodiments of this disclosure. As shown inthe non-limiting example of FIG. 3 , an instance of an ItemType isdeclared through an initial <item> tag 305, which specifies that thisinstance of an item is of the “Part” type and is associated with an“add” method.

The properties 310 of the item are set forth, and include an“item_number” value (which, according to certain embodiments, mayfunction as a unique identifier of the instance of the item) and a“description” value, which, in this case is “Some Assy” (an abbreviationof “some assembly.”)

Container tag 315 specifies that the item has relationships, including afirst relationship 320 with item indicating an “add” method with an itemof the type “Part BOM.” Item configuration 300 further specifies a“related_id” (e.g., child relationship between the “Part BOM” item and achild “part” item 325. Thus, by applying the“/Item/Relationships/Item/Relationships” pattern, a part-to-part BOMrelationship may be described.

FIG. 4 illustrates an example of a system architecture 400 forimplementing a query engine for performing recursive searches in aself-describing data system according to certain embodiments of thisdisclosure. In the non-limiting example of FIG. 4 , network architecturecomprises a database server 405, a backend server 410 implementing queryengine 415, and a front end 420.

According to certain embodiments, database server 405 is a serverhosting data and implementing one or more database applicationssupporting query functionalities. Database server 405 is generallyplatform-agnostic and may host data in a number of known databaseformats, including a relational database format (for example, by runningan instance of .SQL server) or as a columnar database format. In thenon-limiting example of FIG. 4 , database server 405 is communicativelyconnected to backend 410. In some embodiments, this connection isprovided over a network link, and in some other embodiments, backend 410and database server 405 may be embodied on the same piece of hardware.Skilled artisans will appreciate that embodiments according to thisdisclosure may be implemented on a variety of hardware platforms.

According to certain embodiments, database server 405 is configured toreceive queries expressed as statements in a domain-specific language(for example, structured query language), and return results from thedatabase hosted on database server 405.

According to certain embodiments, backend 410 comprises a server orother computer configured to implement a query engine 415 configured toreceive, from front end 420 query requests expressed in the syntax of aself-describing data system (for example, AML). As noted elsewhere,embodiments according to this disclosure are platform-agnostic and maybe practiced across a wide range of hardware configurations anddevelopment environments. In some embodiments, query engine 415 may beimplemented as an ASP.NET web service.

In the non-limiting example of FIG. 4 , front end 420 is communicativelyconnected (for example, via a network or being embodied on the samepiece of hardware) to backend 410. According to certain embodiments,front end 420 comprises a web client of a web service provided bybackend 410, and provides a user interface (UI) through which queriescan be input and query outputs displayed as a user. In certainembodiments, front end 420 may be constructed using modules from theHTML 5 DOJO toolkit. According to certain further embodiments, front end420 may provide an interface through which users can configureparameters of queries and set permissions for queries.

FIG. 5 illustrates operations of a query engine in an example of amethod 500 for performing recursive searches in a self-describing datasystem according to embodiments of this disclosure.

According to the non-limiting example of FIG. 5 , method 500 includesoperation 505, wherein the query engine creates an instance of a querydefinition. As discussed elsewhere in this disclosure, certainembodiments according to this disclosure utilize a self-describing datasystem, wherein the fundamental element of the data system is the item,which is an instance of an ItemType, which is, in turn, itself an item.Further, in certain self-describing data systems according to thisdisclosure, the configuration of items may be expressed through an“/Item/Relationships/Item/Relationships” pattern.

In some embodiments, a query definition is an item, and creating aninstance of a query definition at operation 505 comprises beginning amarkup language document (for example, an AML document) defining theconfiguration of the query definition. Further, a query definition maydefine the set of data (otherwise known as a domain) which a user isinterested in seeing, and which can be collected across one or moredifferent items types and/or relationships using user specified rulesfor filtering. Because a query definition defines the domain of a query,it may also be utilized to implement domain-based access controls todata items within the data structure.

According to certain embodiments, the AML document defining theconfiguration of the query begins with an instance of an <item> tag, anexample of which is provided below:

-   -   <Item action=“qry_Execute QueryDefinition”        type=“qry_QueryDefinition”>

As shown above, according to some embodiments, an <item> tag creating aninstance of a query definition specifies, at a minimum, a type of theinstance of the query, which in this case, is a query definition(specified as “qry_QueryDefinition”), and a method, or action associatedwith the item, which in this case, is an instruction to execute a query,(specified as “qry_Execute Query Definition”). In some embodiments, the<item> tag creating the instance of the query definition item mayfurther comprise a unique ID for the item, which in certain embodiments,may be advantageous if queries or query histories are stored in the datastructure.

As shown in the non-limiting example of FIG. 5 , method 500 includesoperation 510, wherein the query builder, in response to a user input,specifies one or more elements of the query definition. According tocertain embodiments, the one or more specified elements of the querydefinition may be specified as relationships, properties or attributeswithin the document providing the configuration of the query definition.Specifically, the one or more elements may be specified throughadditional items defining relationships or properties, including,without limitation, query items, query item selection properties, queryitem sort properties, query item available properties, query conditionitems and query reference items.

According to certain embodiments, method 500 includes operation 515,wherein the query definition is provided to a query engine. According tosome embodiments, operations 505 and/or 510 may variously be performedat a front end client (for example, front end 420 shown in FIG. 4 ).According to other embodiments, operations 505 and/or 510 may beperformed at the back end or programmatically at the query engineitself. According to certain embodiments, the query engine (for example,query engine 415 in FIG. 4 ) facilitates translating commands from afront end into query definitions, which are then converted intoexecution instructions to be passed to a database server (for example,database server 405 in FIG. 4 ). The query engine may further facilitatethe construction of query definitions, and the provision of queryresults from the database server to the front end.

In some embodiments, method 500 also includes operation 520, wherein thequery engine determines query execution instructions based on thereceived query definition. In the non-limiting example of FIG. 5 ,operation 520 comprises reading the query definition and translating itinto a series of statements in the native language of the databaseserver (for example, .SQL) and properly handling parameters definedwithin the query definition. As will be discussed further in thisdisclosure, as part of operation 520, the query engine may furtherspecify an execution path for the query, as well as, where appropriate,recursion depths for recursive queries. In certain embodiments, thequery execution instructions based on the query definition specify arecursive, level-by-level search of the data.

Additionally, in the non-limiting example of FIG. 5 , the queryexecution instructions determined at operation 520 may be required tosatisfy certain operational constraints, including without limitation,the ability to query a recursive structure, wherein a top level item isfiltered by condition, while items from other levels are not filtered.Further, according to certain embodiments, querying a recursivestructure must be performed without adding a “pseudo” top level item.Additionally, in certain embodiments, the execution instructions mustenable a query of a recursive structure, wherein some intermediate levelis filtered by a condition. Additionally, in some still furtherembodiments, the query execution instructions must enable limiting thedepth of the retrieved structure, without modification of a recursivequery topology.

According to various embodiments, at operation 525, the query engineobtains the results of a query executed based on the query executioninstructions. According to certain embodiments, the results obtained atoperation 525 may comprise generally unformatted data, and the queryengine may assemble a response containing the results of the query.

In some embodiments, at operation 530, the query engine outputs theassembled query results. According to certain embodiments, operation 530comprises returning the query response back to a user or applicationfrom which the request for a query was received (for example, front end420 in FIG. 4 ). According to certain embodiments, the query resultsoutput at operation 530 may comprise a markup language document (forexample, a document in XML, AML or some other extensible markup languagedialect). According to other embodiments, at operation 530, the queryengine may output query results as a flat output, a tree graph view or agraph visualization.

FIG. 6 illustrates, at a structural level, one example of a data model600 supporting a query definition item according to embodiments of thisdisclosure. Note that, in this particular example, data model 600comprises a hierarchical, tree like structure.

As shown in the non-limiting example of FIG. 6 , data model 600 includesa query definition item 605, which occupies the top, or root level ofthe specified elements used to define a query. According to certainembodiments, query definition item 605 is an item of the “QueryDefinition” item type. Query Definition item 605 defines the set of dataa user is interested in seeing. The data belonging to this set can becollected across one or more different Item Types using rules forfiltering. Additionally, access controls can be implemented by definingadditional filters excluding certain users from accessing (by includingwithin the set of data encompassed by the user's query) data. Accordingto certain embodiments, the properties of query definition item comprisea name, which can be a string specifying a unique name for the querydefinition. Additionally, the properties of query definition 605 caninclude a description, which can be a string or text describing the typeof data represented by the query definition. Still further, theproperties of the query definition can include a root query item id,which comprises a string representing the context item (also referred toas a root of the tree structure of data model 600) for query definitiondata model 600. According to other embodiments, properties of the querydefinition may include, without limitation, permissions.

According to certain embodiments, data model 600 is a self-describingdata model which follows an “/Item/Relationship/Item/Relationship”description structure. Accordingly, in data model 600, a federated setof relationship properties 610 through 640 follow query definition 605.These relationships include query item 610. According to certainembodiments, query item 610 may appear as one or more <item> tags withina <relationship> container, such as shown in the example given in FIG. 3. Query item 610 is an item representing the source for properties,including properties to be selected and returned as part of the queryresponse, and joins and filtering to be used, in the query definition.According to certain embodiments, the properties included in query item610 include, without limitation, those set forth in Table 1 below:

TABLE 1 Name Label Type Description classification ClassificationAggregation (GroupBy, SUM, AVG) Union Intersection Special Join itemtypeItem Type Item Item Type which is described by Query Item (Item orRelationship) Alias Alias String Alias of Query Item which will be usedin joins and conditions. condition_ref_id Referenced String ReferencedQuery Condition Condition. ref_id Reference ID String Reference ID ofQuery Item

As shown in the non-limiting example of FIG. 5 , query item 610 may havesource and target relationships (such as described with respect torelationships 210 in FIG. 2 ) with other relationships within data model600. For example, query item 610 may have both a parent and a childrelationship with a query reference 635. Similarly, query item 610 mayalso be indicated as either the source or the target of a relationshipwith query condition 640.

According to certain embodiments, the relationships specified by datamodel 600 comprise query item selection properties 615, which define oridentify which properties from query item 610 to include in the queryresponse. An overview of the properties in one example of query itemselection properties 615 is set forth in Table 2, below:

TABLE 2 Name Label Type Description property_ref_id Property StringReference to qry_QueryItemAvailableProperty via ref_id value.

In some embodiments, the relationships specified by data model comprisequery item sort properties 620, which define which properties from theassociated query item are to be used for sorting data returned by thequery, and how the sort is to be performed. An overview of properties ofquery item sort properties 620 is set forth in Table 3, below:

TABLE 3 Name Label Type Description property_ref_id Property StringReference to qry_QueryItemAvailableProperty via ref_id value. sort_orderSort Order Integer Order of sorting sort_order_direction Sort Order ListValues: Ascending, Descending Direction

According to various embodiments, the relationships specified by datamodel 600 further comprise query item available properties 630. In thenon-limiting example of FIG. 6 , query item available properties 630define which federated properties from the associated query item toinclude in the query response. An overview of properties of query itemavailable properties 630 is set forth in Table 4, below:

TABLE 4 Name Label Type Description source_id Item Reference toqry_QueryItem (qry_QueryItem) name Name String label Label MLString typeType List Data Type of the QueryItem property ref_id Reference StringReference ID (GUID) ID

In the non-limiting example of FIG. 6 , the relationships specified datamodel 600 further comprise query reference 635, which, like the otherrelationships shown in FIG. 6 , may be expressed as an instance of anitem within the <relationship> container tag. According to certainembodiments, query reference 635 defines join requirements between queryitems within the query definition, and as such, implements controls overhow data is collected and aggregated across query items within the querydefinition which have relationships with one another. As shown in TABLE5, below, in some embodiments, query reference 635 operates to specifyrelationships between query items in an analogous manner asrelationships 212 in FIG. 2 . An overview of properties of queryreference 635 is set forth in Table 6, below:

TABLE 6 Name Label Type Description parent_ref_id Parent Item StringReferenced parent Query Item. child_ref_id Child Item String Referencedchild Query Item. condition_ref_id Referenced String Referenced QueryCondition Condition.

According to certain embodiments, the relationships specified withinquery definition data model 600 comprise query condition 640. Querycondition 640 is an instance of an item which defines the filterconditions for the data request. According to certain embodiments, thescope of query condition 640 is the entity on which it is referenced,and a query condition can be optionally associated with a query item andquery reference items. In the case where query condition 640 isreferenced by a query item (for example, query item 610), then querycondition filters the items defined by the query item. If, however, thequery condition is referenced by a query reference (for example, queryreference 635), it operates to filter the items defined by a query itemreferenced as the child query item for the query reference. An overviewof properties of query condition 640 is set forth in Table 7 below:

TABLE 7 Name Label Type Description condition_xml Condition Xml Text Xmlrepresentation of specified conditions. ref_id Reference ID StringReference ID of Query Condition.

FIGS. 7A and 7B illustrate an example of a markup language configurationdocument 700 setting forth the configuration of a query constructedbased on a self-describing data model (for example, data model 600 inFIG. 6 ) according to embodiments of this disclosure.

As shown in the non-limiting example of FIGS. 7A and 7B, configurationdocument 700 includes an <item> tag 705 creating an instance of thequery definition, whose properties include the action or method“qry_ExecuteQueryDefinition.”

Referring to the non-limiting example of FIGS. 7A and 7B, configurationdocument 700 further includes three query condition items 710 a, 710 band 710 c specifying filters to be applied in the query. In thisparticular example, the properties of each of query condition items 710a through 710 c are further specified by attributes further controllingthe execution logic of the query. For example, in query condition item710, the <condition> attribute is used to define the filter, as shown bythe statement “<![CDATA[<condition> <eq> <propertyref-id=“TopPart_id_GUID”/><propertyref-id=“PBom_sourceId_GUID”I></eq></condition>]]>”.

Configuration document 700 further includes query items 715 a, 715 b and715 c which, set forth properties to be part of the query response, andthe properties to be used in joins and filtering. For example, queryitem 715 a specifies an item, having the name “part” and the attribute“keyed_name,” with the value “4F1AC04A2B484F3ABA4E20DB63808A88” as afilter for items to be returned by the query.

In the non-limiting example of FIGS. 7A and 7B, query document 700further comprises query item selection properties 720 a, 720 b, 720 cand 720 d, which variously specify properties from query items 715 a and715 c to include in the query response. For example, query itemselection property 720 a specifies the property “TopPart_id” as aproperty to be returned with query response items satisfying the filtercriterion “keyed_name”=“4F1AC04A2B484F3ABA4E20DB63808A88” specified byquery item 715 a.

Additionally, in this illustrative example, query document 700 furthercomprises an instance 725 of a query item sort property. In thenon-limiting example of FIGS. 7A and 7B, instance 725 of a query itemsort property specifies “TopPart_name” as the property to sort the itemsin the query response, and instance 725 of query item sort propertyincludes the attribute “sort_order_direction” whose value “Ascending”indicates that the query response items are to be sorted by“TopPart_name” in ascending order.

As shown in the non-limiting example of FIGS. 7A and 7B, query document700 further includes query reference items 730 a and 730 b, whichspecify how, in executing the query, data is collected and aggregatedacross query items which have relationships with other query itemswithin the query definition. In this particular example, query referenceitems 730 a and 730 b specify join requirements, as shown, for example,by the property “<condition_ref_id>join_cond_1</condition_ref_id> ” inquery reference item 730 a.

FIG. 8 illustrates, at a structural level, an exemplary embodiment of anextension of a data model 800 for configuring recursive searches of aself-describing data system.

In the non-limiting example of FIG. 8 , data model 800 is represented ashaving a hierarchical tree structure, with query definition item 805 asthe root, or context item type. Further, according to certainembodiments, data model 800 represents a query in a self-describing datasystem, whose elements follow a regular“/Item/Relationship/Item/Relationship” pattern.

Data model 800 may, according to various embodiments, include a varietyof types of items 810 specifying relationships within the querydefinition. These items may comprise, for example, items 610-640 in FIG.6 , or a subset or superset thereof. Additionally, according to certainembodiments, data model 800 may further comprise items 815 belonging tothe query parameter item type. According to various embodiments, queryparameters comprise a user-defined parameter within query conditionswhich can be supplied at query execution time to override defaultvalues. Additionally, query parameters may also be used in otherassignable values within a query definition, such as in offset and fetchvalues. The values for the parameters specified within the queryparameter item may then be assigned at the time the query definition isto be executed.

Additionally, items 815 belonging to the query parameter item type mayalso be utilized to track or control aspects of the execution of aquery. For example, according to certain embodiments, a user designedparameter “@ExecutionPath” is a dynamic parameter which may becalculated while processing a query definition to determine the progressof a query. Additionally, according to certain embodiments, items 815belonging to the query parameter item type may also be used to define aquery execution path, reflecting a route from a parent query item to achild query item in a query definition. Still further, items 815belonging to the query parameter item type may be used to control thedepth (i.e., how many levels are traversed) of recursion of a recursivequery. According to some embodiments, a query engine (for example, queryengine 415 in FIG. 4 ) will, by default and in the absence of a queryparameter item specifying otherwise, exhaustively traverse all recursivepaths.

FIG. 9 illustrates an embodiment of a query configuration document 900comprising an instance of an item 905 belonging to the query parameteritem type which provides a user-defined filter on the query responsedata set. As shown in the non-limiting example of FIG. 9 , the containertag 907 “<Parameters> ” signals the creation of the user-definedparameter having the name “@PartNumber,” and the value “IN-0001.”Further, as shown in FIG. 9 , the parameter “@PartNumber” is specifiedas a filtering property 910 of a query response data set.

FIG. 10 illustrates an embodiment of a query configuration document 1000comprising an instance 1005 of items belonging to the query parameteritem type, by which the execution path of the query, in particular, thequery recursion depth, may be controlled by defining a conditiondependent on a value of the query parameter item. As shown in thenon-limiting example of FIG. 10 , an instance 1005 of the queryparameter item defines the parameter named “@Levels,” as being of aninteger type. Once defined, the “@Level” parameter, in conjunction withthe “@ExecutionPath” parameter is used as a value in conditional 1010,which determines the depth of the recursive query defined by queryconfiguration document 1000.

FIG. 11 illustrates, in wireframe format, a query execution path 1100 ofa query (for example, the query described by query configurationdocument 1000 in FIG. 10 ). In the non-limiting example of FIG. 11 , twoitems of the query parameter type are used to control query executionpath. In this particular example, the first item 1105 of the queryparameter type is the dynamic parameter “@ExecutionPath,” and the seconditem 1110 of the query parameter type is the parameter “@Levels.”

According to various embodiments, “@ExecutionPath” is a parametercalculated by a query execution engine (which according to certainembodiments, may be embodied as part of a query engine, such as, forexample, query engine 415 in FIG. 4 ) tracking where the query executionengine is during the execution of a query definition. According tocertain embodiments, query parameter “@ExecutionPath” is an item in aself-describing data system of the type “Path.” In this particularexample, the value of query parameter “@ExecutionPath” is a stringreflecting a route from a parent query item (for example, query item 610in FIG. 6 ) to a child query item via one or more query references (forexample, query reference item 730 a in FIG. 7 ).

In some embodiments, the query parameter “@Levels” is a parameterspecifying the number of levels to “drill down” in a recursive search.Thus, in the example of FIG. 11 , the execution path of the query,specifically, the items which are fetched while executing the query, isdefined by the filter 1115 “if@ExecutionPath==“QR1/(QR2/QR1){@Levels/}/” then Fetch(0).” In thisnon-limiting example, if the value of the parameter “@Levels” is zero,then the query pulls no items, because /QR1(/(QR2/QR1){0}/ is equal to“/QR1/” limiting the path of the “Part” query to “Part BOM.” If“@Levels”=1, then the query “drills down” one level and fetches the root“Part.” If “@Levels”=2, then the query “drills down” two levels,fetching the root “Part” and its children. Similarly, if “@Levels” =3,then the query “drills down” three levels within the hierarchy of thedata structure, fetching the root “Part”, its children and theirchildren.

After an execution engine implements execution instructions based on thequery definition, query engines according to certain embodiments of thisdisclosure obtain the results of the executed query and output the queryresults.

FIGS. 12A and 12B illustrate an example of a markup language document1200 comprising query results obtained and outputted in a structuredformat. Specifically, markup language document 1200 comprises AML formatresults of the recursive query configured by query configurationdocument 700 shown in FIGS. 7A and 7B of this disclosure. According tocertain embodiments, a query response, such as provided by document 1200comprises the results of a query executed according to a querydefinition.

As shown in the non-limiting example of FIGS. 12A and 12B, query results1200 mirror the “/Item/Relationship/Item/Relationship” structuralpattern of the query definition and other documents constructedaccording to a self-describing data model. As shown in FIGS. 12A and12B, the query returned results 1205 a through 1205 g, which, asspecified by query item selection property 720 c in FIG. 7 belong to theitem type “Top Part.” Further, as discussed elsewhere in thisdisclosure, in the absence of a query parameter item overriding adefault recursion depth, the query was executed until a terminal nodefor each item in the query definition was reached, as shown by, forexample, result 1205 b.

According to certain embodiments, a query engine may output queryresults in a structured format, such as the structured format of thequery definition (for example, as shown in FIGS. 12A and 12B) of thisdisclosure. According to certain other embodiments, the query engine mayoutput results according to a different structural format, such as agraph visualization.

As shown by FIG. 13 , a query engine according to certain embodiments ofthis disclosure may output query results in a tree grid format. In thenon-limiting example of FIG. 13 , a view 1300 of a user interface (suchas presented by front end 420 in FIG. 4 ) showing query results 1305 ina tree grid view. According to embodiments, the tree grid view enablesthe query results to be displayed in a way that reflects the structureof the query definition by which they were obtained. As such, accordingto certain embodiments, query result items are displayed in ahierarchical manner reflecting their relationship to a context item, orroot node, and which displays the relationship between items obtained bythe executed query. In this particular example, query results 1305 areshown according to their relationship to context item, or root node“P-123,” which in this example, corresponds to a “MakerBot Replicator.”According to certain embodiments, the leftmost column 1315 of the treegrid view indicates hierarchical (i.e., parent-child relationshipbetween the displayed items), while the columns to the right 1320indicate properties of the items returned by the executed query.

According to certain embodiments or under certain conditions (forexample, when performing very, very large queries, such as queries of abill of materials for a helicopter, which when expressed as items in aself-describing data structure, may comprise a data structure with˜30,000,000 item nodes) the performance of the query engine may beimproved by outputting the query results in a “flat” or unstructuredformat. In contrast to certain structured output formats according toembodiments of this disclosure, wherein the query results are outputtedin a manner that reflects and allows reconstruction of, the hierarchyand relationships within the query structure and query execution path, a“flat” output may adhere to a simplified structure, wherein only “keyproperties” are displayed. In this way, the file size of the queryresult may be made more manageable.

FIG. 14A illustrates an example of a query result set 1400 of anexecuted query which has been output in a structured format, in thiscase AML. In this non-limiting example, a significant portion of theoutput 1405 is dedicated to </Relationship> container tags forexpressing the hierarchy of relationships between items in the resultset.

FIG. 14B illustrates an example of a query result set 1410 for the samequery as in FIG. 14A, which has been output in a flat format with “id”defined as a key property of the output. Skilled artisans willappreciate that result set 1405 may be more readily processed thanresult set 1400 in the absence of an extended hierarchy defined bymultiple </Relationship> container tags 1405. Further, according tocertain embodiments, query result set 1400 may be readily converted intoa structured result by calling the “qry_ConvertFlatToStructuredResult”method of the Aras IOM API.

The functionality and performance of query engines according toembodiments of this disclosure may be further enhanced by through theuse of extended classification items. Extending the data model of aself-describing data system through the use of extended classificationsmay enhance the ability of the query engine to perform queries ofpolyhierarchical relationships, equivalence and associativerelationships. Further, extended classifications according toembodiments of this disclosure may enhance the operation of a queryengine, by enabling users to add additional properties to an item,without changing the underlying item type of the item. In this way,searches across the additional properties may be conducted quickly, inthat the result set will not necessarily include null classes for theitem instances not having the newly added (or extended) properties.

According to certain embodiments, an extended classification encompassesa kind of item, defining a collection of properties, which are specificto an object classified by a term. Further, in some embodiments, anextended property comprises a property which exists on a global scopeand which is not specific to any one item type. According to certainembodiments, extended properties may be defined via one or more extendedclassifications.

FIG. 15 illustrates a data model 1500 for implementing extendedproperties in a self-describing data system according to variousembodiments of this disclosure.

As shown in the non-limiting example of FIG. 15 , data model 1500 ishierarchical and anchored, or rooted to an instance of an item type1505, whose properties include an “id” value 1510 which operates as aprimary key specifying relationships between instance of an item type1505 and extended property items 1515-1535.

According to various embodiments, data model 1500 describes aself-describing system whose items follow an“/Item/Relationship/Item/Relationship” structural pattern. Further, datamodel 1500 comprises xPropertyDefinition ItemType 1530, which defines aproperty which is defined on a global scope and is not specific to anyone item type. As shown in FIG. 15 , xPropertyDefinition ItemType 1530is a child of ItemType_xPropertyDefinition Relationship Type 1520. Alist of properties supported by xProperty Definition ItemType 1530 isshown in TABLE 8 below:

TABLE 8 Property Name Label Data Type name Name string (32) label Labelml_string data_type Data Type list (Data Types) data_source Data SourceItem (ItemType) stored_length Length integer prec Precision integerscale Scale integer is_required Required boolean is_indexed Indexedboolean column_alignment Alignment list (Text Alignment) column_widthWidth integer default_value Default Value ml_string pattern Patternstring (512) readonly Read Only boolean help_tooltip Tooltip ml_stringtrack_history Track History boolean

According to certain embodiments, data model 1500 further comprisesItemType_xPropertyDefinition Relationship Type 1520, which describes alink between a particular ItemType and an xPropertyDefinition ItemType1530. According to various embodiments, any xProperty Definition can beassigned to multiple ItemTypes and any ItemType may have multipleassigned)(Property definitions.

As shown in the non-limiting example of FIG. 15 , data model 1500 mayfurther comprise xItemTypeAllowedProperty Relationship Type 1525.According to certain embodiments, xItemTypeAllowedProperty RelationshipType 1525 describes a link between a particular ItemType and anxPropertyDefinition, which contains all allowed xProperties for theItemType. As used in this disclosure, an allowed xProperty refers to anxProperty assigned to a particular ItemType, and which is the onlyxProperty which can be defined on Items of that particular ItemType.

According to certain embodiments, data model 1500 comprisesxPropertyContainerItem 1535, which describes an ItemType which has atleast one allowed xPropertyDefinition. When an xPropertyDefinition isassigned to this ItemType, this ItemType will be added to a list ofpolymorphic sources of xPropertyContainerItem 1535.

In some embodiments according to this disclosure, data model comprises atable of xPropertyValues 1515. As noted elsewhere in this disclosure,the implementation of extended classifications and extended propertiesenables properties to be dynamically added or removed from an instanceof an ItemType without changing the type of the item. According to someembodiments, this may be accomplished by maintaining the values of theextended properties in a separate table from the items to which theyrelate.

As discussed elsewhere in this disclosure, an extended classification isa type of item which defines a collection of properties, which may bespecific to an object classified by a term. FIG. 16 illustrates anexample of a data model 1600 for implementing extended classification ina self-describing data system according to embodiments of thisdisclosure.

In the non-limiting example of FIG. 16 , data model 1600 comprises, asits context item, or root, an instance of xClassificationTree ItemType1605. According to embodiments, xClassificationTree ItemType 1605defines a taxonomy, which is a collection of terms (also referred to as“xClasses,” organized into a hierarchical structure. xClassificationTreeItemType 1605, is, according to certain embodiments, a self-containedunit which contains xClasses which are specific to only that tree. Theproperties of xClassficationTree_ItemType 1605, according to certainembodiments are shown in Table 9, below:

TABLE 9 Property Name Label Data Type name Name string (32) item_numberNumber string (32) description Description text classification_hierarchyClassification Hierarchy text label Label ml_stringselect_only_leaf_class Restrict Selection to only Leaf boolean Classesselect_only_single_class Restrict Selection to a Single boolean Class

According to embodiments, data model 1600 may further comprisexClassificationTree_ItemType RelationshipType 1610, which defines a listof dimensions available for xClassificationTree ItemType 1605.xClassificationTree_ItemType RelationshipType 1610 may further beassociated with one or more ItemTypes 1615.

In various embodiments according to this disclosure, data model 1600 mayfurther comprise xClass Relationship Type 1620. As noted elsewhereinstances of XClass represent a concept named by a term, which in turndefine a collection of properties, further specified by xClass_XPropertyDefinition Relationship Type 1625.

In the non-limiting example of FIG. 16 , data model 1600 includesxClass_xPropertyDefinition Relationship Type 1625, which describes alink between a particular xClass and an xPropertyDefinition.

Additionally, data model 1600 may further comprise instances ofxClass_xProperty_Flatten Relationship Type 1630, which, describes a linkbetween a particular xClass and xPropertyDefinition, and which containsall of the xProperties of a given xClass, including both the xClass'sown properties and its inherited properties. According to someembodiments, a list of inherited properties may be calculated based on ahierarchy reflected in xClassificationTree ItemType 1605. As shown inthe non-limiting example of FIG. 16 , xClass_xPropertyDefinitionRelationship Type 1625 and xClass_xProperty_Flatten Relationship Type1630, are in turn, lied to at least one instance of xPropertyDefinitionItemType 1635.

None of the description in this application should be read as implyingthat any particular element, step, or function is an essential elementthat must be included in the claim scope. The scope of patented subjectmatter is defined only by the claims. Moreover, none of the claims isintended to invoke 35 U.S.C. § 112(f) unless the exact words “means for”are followed by a participle.

What is claimed is:
 1. A method for performing recursive searching ofitems of a data structure having a data model, the method comprising:creating an instance of a query definition, the instance of the querydefinition comprising a unique identifier and defining a depth parameterhaving a name and a value that controls a depth of a recursivelevel-by-level search of the data structure; specifying one or moreelements of the query definition to be executed as instructions in asingle query by a query engine, wherein the one or more elementscomprise a query condition including a first dynamic parameter of anexecution path comprising a string defining a search route from a parentquery item to a child query item and the string references a keyassociated with the name of the depth parameter having the value thatcontrols the depth of the recursive level-by-level search of the datastructure, wherein the first dynamic parameter and the depth parameterare each a respective instance of an item in the data model, and whereinthe depth parameter is configured in a configuration document that alsoconfigures the key and the string defining the search route from theparent query item to the child query item; providing the querydefinition as an input to the query engine; determining, by the queryengine, query execution instructions based on the query definition, thequery instructions specifying the recursive level-by-level search, thequery engine further calculating the dynamic parameter and using thedynamic parameter with the depth parameter to control the recursivelevel-by-level search; obtaining results of a query executed based onthe query execution instructions; and outputting query results.
 2. Themethod of claim 1, wherein outputting the query results comprises atleast one of outputting the query results as a flat output, displayingthe results in a tree grid view or displaying the results as a graphvisualization.
 3. The method of claim 1, wherein an element of the querydefinition is specified by a security rule.
 4. The method of claim 1,wherein the data model of the data structure is at least one of ahierarchical data model, a dynamic data model or a self-describing datamodel.
 5. The method of claim 1, wherein specifying the elements of thequery definition comprises at least one of specifying a query item, aquery item selection property, a query item sort property, a query itemavailable property, or a query reference.
 6. The method of claim 1,further comprising storing the query definition in the data structure.7. The method of claim 1, wherein the query execution instructionsspecify at least one of traversing the data structure upwards ortraversing the data structure downwards.
 8. A query engine, comprising:a processor; a memory containing instructions, which when executed bythe processor, cause the query engine to: create an instance of a querydefinition, the instance of the query definition comprising a uniqueidentifier and defining a depth parameter having a name and a value thatcontrols a depth of a recursive level-by-level search of the datastructure, obtain one or more elements of the query definition to beexecuted as instructions in a single query by the query engine, whereinthe one or more elements comprise a query condition including a firstdynamic parameter of an execution path comprising a string defining asearch route from a parent query item to a child query item and thestring references a key associated with the name of the depth parameterhaving the value that controls the depth of the recursive level-by-levelsearch of the data structure, wherein the first dynamic parameter andthe depth parameter are each a respective instance of an item in thedata model, and wherein the depth parameter is configured in aconfiguration document that also configures the key and the stringdefining the search route from the parent query item to the child queryitem, provide the query definition as an input to the query engine,determine query execution instructions based on the query definition,the query execution instructions specifying the recursive level-by-levelsearch, the query engine further calculating the dynamic parameter andusing the dynamic parameter with the depth parameter to control therecursive level-by-level search; obtain results of a query executedbased on the query execution instructions, and output the query results.9. The query engine of claim 8, wherein the memory containsinstructions, which when executed by the processor, cause the queryengine to output the query results as at least one of outputting thequery results as a flat output, displaying the results in a tree gridview or displaying the results as a graph visualization.
 10. The queryengine of claim 8, wherein an element of the query definition isspecified by a security rule.
 11. The query engine of claim 8, whereinthe data model of the data structure is at least one of a hierarchicaldata model, a dynamic data model or a self-describing data model. 12.The query engine of claim 8, wherein the elements of the querydefinition comprise at least one of a query item, a query item selectionproperty, a query item sort property, a query item available property,or a query reference.
 13. The query engine of claim 8, wherein thememory contains instructions, which when executed by the processor,cause the query engine to store the query definition in the datastructure.
 14. The query engine of claim 8, wherein the query executioninstructions specify at least one of traversing the data structureupwards or traversing the data structure downwards.
 15. A non-transitorycomputer-readable medium containing program code, which when executed bya processor, cause a query engine to: create an instance of a querydefinition, the instance of the query definition comprising a uniqueidentifier and defining a depth parameter having a name and a value thatcontrols a depth of a recursive level-by-level search of the datastructure, obtain one or more elements of the query definition to beexecuted as instructions in a single query by the query engine, whereinthe one or more elements comprise a query condition including a firstdynamic parameter of an execution path comprising a string defining asearch route from a parent query item to a child query item and thestring references a key associated with the name of the depth parameterhaving the value that controls the depth of the recursive level-by-levelsearch of the data structure, wherein the first dynamic parameter andthe depth parameter are each a respective instance of an item in thedata model, and wherein the depth parameter is configured in aconfiguration document that also configures the key and the stringdefining the search route from the parent query item to the child queryitem, provide the query definition as an input to the query engine,determine query execution instructions based on the query definition,the query execution instructions specifying the recursive level-by-levelsearch, the query engine further calculating the dynamic parameter andusing the dynamic parameter with the depth parameter to control therecursive level-by-level search, obtain results of a query executedbased on the query execution instructions, and output the query results.16. The non-transitory computer-readable medium of claim 15, comprisingprogram code, which when executed by the processor, cause the queryengine to output the query results as at least one of outputting thequery results as a flat output, displaying the results in a tree gridview or displaying the results as a graph visualization.
 17. Thenon-transitory computer-readable medium of claim 15, wherein an elementof the query definition is specified by a security rule.
 18. Thenon-transitory computer-readable medium of claim 15, wherein the datamodel of the data structure is at least one of a hierarchical datamodel, a dynamic data model or a self-describing data model.
 19. Thenon-transitory computer-readable medium of claim 15, the elements of thequery definition comprise at least one of a query item, a query itemselection property, a query item sort property, a query item availableproperty, or a query reference.
 20. The non-transitory computer-readablemedium of claim 15, comprising program code, which when executed by theprocessor, causes the query engine to store the query definition in thedata structure.